Formatting the Diagnostic String
To modify the format of the diagnostic string, the following option can be used:
format-string
is a quoted string in which the following specifiers are recognized:
Specifier | Description |
---|---|
%B | Base file name |
%c | Column number |
%C | Column number less 1 (left column is 0) |
%e | Message extension information, e.g. message reference text (requires <message_extension> tag in the RCF file) |
%f | File name |
%F | File name (absolute, including path) |
%g | Message level |
%G | Parent Rule Id(s) 1 |
%H | Message help file (absolute path) |
%I | All Rule Ids 12 |
%j | Suppression justification |
%K | Rule Categories 1 2 |
%l |
Line number |
%m | Suppression Macro Name |
%M | Rule Group Name and last child Rule Id(s) 1 |
%n | Message number (raw integer format) |
%N | Message number (zero padded to four digits) |
%p | Component for which the diagnostics are being produced (for example "qacpp-4.1") |
%r | Last child Rule Id(s) 1 |
%S | Suppression type |
%t | Message text |
%u | Context message depth |
%v | Rule Id(s) and text (must have ‑‑rules set) |
%Y | Severity |
%z | Rule help file(s) (absolute path 1) |
%^ | if the column is not zero and the message is not a submessage for different line or filename, update last location, show the caret and insert a newline. |
1 Fields for each rule are ',' (comma) separated.
2 Individual elements within a rule are '|' (bar) separated.
Rules are hierarchical. Any Rule entry will refer to the lowest entry in the hierarchy, unless it is explicitly specified, such as "Parent Rule Id". This refers to the Rule Id highest in the hierarchy.
Suppression Types
The suppression type is a single digit decimal bitmap that denotes the types of suppression that are active for a diagnostic. A value of ’0’ indicates that no suppressions are active. The following bits may be set:
Bit 5 | Bit 4 | Bit 3 | Bit 2 | Bit 1 | Decimal | Meaning |
---|---|---|---|---|---|---|
0 | 0 | 0 | 0 | 0 | 0 | None |
0 | 0 | 0 | 0 | 1 | 1 | Comment |
0 | 0 | 0 | 1 | 0 | 2 | Pragma |
0 | 0 | 0 | 1 | 1 | 3 | Comment + Pragma |
0 | 0 | 1 | 0 | 0 | 4 | Baseline |
0 | 0 | 1 | 0 | 1 | 5 | Comment + Baseline |
0 | 0 | 1 | 1 | 0 | 6 | Pragma + Baseline |
0 | 0 | 1 | 1 | 1 | 7 | Comment + Pragma + Baseline |
0 | 1 | 0 | 0 | 0 | 8 | Macro |
0 | 1 | 0 | 0 | 1 | 9 | Comment + Macro |
0 | 1 | 0 | 1 | 0 | 10 | Pragma + Macro |
0 | 1 | 0 | 1 | 1 | 11 | Comment + Pragma + Macro |
0 | 1 | 1 | 0 | 0 | 12 | Baseline + Macro |
0 | 1 | 1 | 0 | 1 | 13 | Comment + Baseline + Macro |
0 | 1 | 1 | 1 | 0 | 14 | Pragma + Baseline + Macro |
0 | 1 | 1 | 1 | 1 | 15 | Comment + Pragma + Baseline + Macro |
1 | 0 | 0 | 0 | 0 | 16 | Interactive |
1 | 0 | 0 | 0 | 1 | 17 | Comment + Interactive |
1 | 0 | 0 | 1 | 0 | 18 | Pragma + Interactive |
1 | 0 | 0 | 1 | 1 | 19 | Comment + Pragma + Interactive |
1 | 0 | 1 | 0 | 0 | 20 | Baseline + Interactive |
1 | 0 | 1 | 0 | 1 | 21 | Comment + Baseline + Interactive |
1 | 0 | 1 | 1 | 0 | 22 | Pragma + Baseline + Interactive |
1 | 0 | 1 | 1 | 1 | 23 | Comment + Pragma + Baseline + Interactive |
1 | 1 | 0 | 0 | 0 | 24 | Macro + Interactive |
1 | 1 | 0 | 0 | 1 | 25 | Comment + Macro + Interactive |
1 | 1 | 0 | 1 | 0 | 26 | Pragma + Macro + Interactive |
1 | 1 | 0 | 1 | 1 | 27 | Comment + Pragma + Macro + Interactive |
1 | 1 | 1 | 0 | 0 | 28 | Baseline + Macro + Interactive |
1 | 1 | 1 | 0 | 1 | 29 | Comment + Baseline + Macro + Interactive |
1 | 1 | 1 | 1 | 0 | 30 | Pragma + Baseline + Macro + Interactive |
1 | 1 | 1 | 1 | 1 | 31 | Comment + Pragma + Baseline + Macro + Interactive |
Dashboard and Validate are synonyms for Interactive.